Home Erkunden Hilfe
Registrieren Anmelden
J1X
/
huginn
Beobachten 2
Markieren 0
Fork 0

Quellcode durchsuchen
Working public transport agent, currently works for san francisco muni by default configuration

Umar M. Sheikh vor 11 Jahren
Ursprung
a5321938e7
Commit
667d8d022c
3 geänderte Dateien mit 134 neuen Zeilen und 0 gelöschten Zeilen
Diff-Statistik anzeigen
  1. 1 0
      Gemfile
  2. 2 0
      Gemfile.lock
  3. 131 0
      app/models/agents/public_transport_agent.rb

+ 1 - 0
Gemfile
Datei anzeigen 

@@ -4,6 +4,7 @@ gem 'rails'
4 4 
 gem 'rake'
5 5 
 gem 'mysql2'
6 6 
 gem 'devise'
7 
+gem "patron"
7 8 
 gem 'kaminari'
8 9 
 gem 'bootstrap-kaminari-views'
9 10 
 gem "rufus-scheduler", :require => false

+ 2 - 0
Gemfile.lock
Datei anzeigen 

@@ -138,6 +138,7 @@ GEM
138 138 
       multi_xml (~> 0.5)
139 139 
       rack (~> 1.2)
140 140 
     orm_adapter (0.4.0)
141 
+    patron (0.4.18)
141 142 
     polyglot (0.3.3)
142 143 
     pry (0.9.12.2)
143 144 
       coderay (~> 1.0.5)
 
@@ -280,6 +281,7 @@ DEPENDENCIES
280 281 
   kramdown
281 282 
   mysql2
282 283 
   nokogiri
284 
+  patron
283 285 
   pry
284 286 
   rails
285 287 
   rake

+ 131 - 0
app/models/agents/public_transport_agent.rb
Datei anzeigen 

@@ -0,0 +1,131 @@
1 
+require 'date'
2 
+require 'cgi'
3 
+module Agents
4 
+  class PublicTransportAgent < Agent
5 
+    cannot_receive_events!
6 
+    description <<-MD
7 
+      The Public Transport Agent monitors if any bus is expected to arrive at a particular stop in 5 minutes or less.
8 
+      You must specify 5 things for it too work correctly. Your state, city, route, stop and destination. All these things
9 
+      should be in the language that nextbus understands. For details check out http://www.nextbus.com/predictor/stopSelector.jsp?a=sf-muni and http://www.apihub.com/nextbus/api/nextbus-api/docs/reference.
10 
+
11 
+      Specify the following user settings:
12 
+        - stops (array)
13 
+        - agency (string)
14 
+        - alert_window_in_minutes (integer)
15 
+
16 
+
17 
+
18 
+      This Agent generates Events based on NextBus GPS transit predictions.  First, select an agency by visiting http://www.nextbus.com/predictor/agencySelector.jsp and finding your transit system.  Once you find it, copy the part of the URL after `?a=`.  For example, for the San Francisco MUNI system, you would end up on http://www.nextbus.com/predictor/stopSelector.jsp?a=sf-muni and copy "sf-muni".  Put that into this Agent's agency setting.
19 
+
20 
+      Next, find the stop tags that you care about.  To find the tags for the sf-muni system, for the N route, visit this URL:
21 
+      http://webservices.nextbus.com/service/publicXMLFeed?command=routeConfig&a=sf-muni&r=N
22 
+
23 
+      The tags are listed as tag="1234".  Copy that number and add the route before it, separated by a pipe (|) symbol.  Once you have one or more tags from that page, add them to this Agent's stop list.  E.g,
24 
+
25 
+          agency: "sf-muni"
26 
+          stops: ["N|5221", "N|5215"]
27 
+
28 
+      This Agent will generate predictions by requesting a URL similar to the following:
29 
+
30 
+      http://webservices.nextbus.com/service/publicXMLFeed?command=predictionsForMultiStops&a=sf-muni&stops=N|5221&stops=N|5215
31 
+
32 
+      Finally, set the arrival window that you're interested in.  E.g., 5 minutes.  Events will be created by the agent anytime a new train or bus comes into that time window.
33 
+
34 
+    alert_window_in_minutes: 5
35 
+
36 
+
37 
+having the agent's default check period be every minute, and creating an Event in #check whenever a new tripTag (supplied by the predictionsForMultiStops API) shows up within alert_window_in_minutes from the stop.  Do not create events for the same tripTag more than once per stop.  I'd do this by keeping a list of [stop tag, tripTag, timestamp] tuples in memory and checking to make sure one doesn't already exist before making a new Event.  This memory should get cleaned up when timestamp is older than an hour (or something) so that it doesn't fill up all of the Agent's memory.
38 
+
39 
+The NextBusAgent doesn't need to receive Events.
40 
+
41 
+It needs to fetch XML from one URL, store a list of timestamps in memory, and make Events.
42 
+
43 
+
44 
+    MD
45 
+
46 
+
47 
+    default_schedule "every_2m"
48 
+
49 
+    event_description <<-MD
50 
+    Events look like this:
51 
+      { "routeTitle":"N-Judah",
52 
+        "stopTag":"5215",
53 
+        "prediction":
54 
+           {"epochTime":"1389622846689",
55 
+            "seconds":"3454","minutes":"57","isDeparture":"false",
56 
+            "affectedByLayover":"true","dirTag":"N__OB4KJU","vehicle":"1489",
57 
+            "block":"9709","tripTag":"5840086"
58 
+            }
59 
+      }
60 
+    MD
61 
+    def session
62 
+      @session ||= Patron::Session.new
63 
+      @session.connect_timeout = 10
64 
+      @session.timeout = 60
65 
+      @session.headers['Accept-Language'] = 'en-us,en;q=0.5'
66 
+      @session.headers['User-Agent'] = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_4; en-US) AppleWebKit/534.12 (KHTML, like Gecko) Chrome/9.0.584.0 Safari/534.12"
67 
+      @session
68 
+    end
69 
+    def check_me
70 
+      binding.pry
71 
+    end
72 
+    def check_url
73 
+
74 
+      stop_query = URI.encode(options["stops"].collect{|a| "&stops=#{a}"}.join)
75 
+
76 
+      u  = "http://webservices.nextbus.com/service/publicXMLFeed?command=predictionsForMultiStops&a=#{options["agency"]}#{stop_query}"
77 
+      log "Fetching #{u}"
78 
+      u
79 
+    end
80 
+    def stops
81 
+      options["stops"].collect{|a| a.split("|").last}
82 
+    end
83 
+    def check
84 
+      puts "*************************\n\n\n\nI get called!!!\n\n\n\n**************************************"
85 
+      page = session.get(check_url)
86 
+      page = Nokogiri::XML page.body
87 
+      predictions = page.css("//prediction")
88 
+      puts "predictions #{predictions.to_xml}"
89 
+      puts "minutes #{predictions.collect{|a| a["minutes"]}.join(",")}"
90 
+      predictions.each do |pr|
91 
+        parent = pr.parent.parent
92 
+        vals = {routeTitle: parent["routeTitle"], stopTag: parent["stopTag"]}
93 
+        if pr["minutes"] && pr["minutes"].to_i < 60
94 
+          vals = vals.merge Hash.from_xml(pr.to_xml)
95 
+          if not_already_in_memory?(vals)
96 
+            create_event(:payload => vals)
97 
+            add_to_memory(vals)
98 
+          else
99 
+          end
100 
+        end
101 
+      end
102 
+    end
103 
+    def add_to_memory(vals)
104 
+      self.memory["existing_routes"] ||= []
105 
+      self.memory["existing_routes"] << {stopTag: vals["stopTag"], tripTag: vals["prediction"]["tripTag"], epochTime: vals["prediction"]["epochTime"], currentTime: Time.now}
106 
+    end
107 
+    def not_already_in_memory?(vals)
108 
+      m = self.memory["existing_routes"]
109 
+      m.select{|h| h[:stopTag] == vals["stopTag"] &&
110 
+                h[:tripTag] == vals["prediction"]["tripTag"] &&
111 
+                h[:epochTime] == vals["prediction"]["epochTime"]
112 
+              }.count == 0
113 
+    end
114 
+    def default_options
115 
+      {
116 
+        agency: "sf-muni",
117 
+        stops: ["N|5221", "N|5215"],
118 
+        alert_window_in_minutes: 5
119 
+      }
120 
+    end
121 
+
122 
+    def validate_options
123 
+      errors.add(:base, 'agency is required') unless options['agency'].present?
124 
+      errors.add(:base, 'alert_window_in_minutes is required') unless options['alert_window_in_minutes'].present?
125 
+      errors.add(:base, 'stops are required') unless options['stops'].present?
126 
+    end
127 
+    def working?
128 
+      event_created_within?(2) && !recent_error_logs?
129 
+    end
130 
+  end
131 
+end